Categories and collections #228

benbalter · 2018-05-08T16:29:45Z

This pull request builds on @mortenson's work in #176 to fix #70 by abstracting some of the existing logic out a bit. Specifically, it supports generating feeds for categories (and collections other than posts).

To generate feeds for categories:

feed:
  categories:
    - news
    - updates

And to generate feeds for collections:

feed:
  collections:
    - changes

Since posts are a collection, it's also possible to generate category feeds for other collections:

feed:
  collections:
    changes:
      categories:
        - news
        - updates

Everything is backwards compatible with the existing configuration flags, such that:

feed:
  path: "foo.xml"

Automatically gets converted to:

feed:
  collections:
    posts: 
      path: "foo.xml"

So this should be a non-breaking change, and theoretically add as little complexity as necessary to the publishing experience (in most cases, just creating a top-level list in the config to make it opt-in).

By default, categories are in the form of /feed/<category>.xml, collections are /feed/<collection>.xml, and collection categories are /feed/<collection>/<category>/xml.

All this is implemented with a small abstraction in the generator, which passes the collection (defaulting to posts) and optionally the category to the existing template.

…ll-feed into mortenson-feed-per-category

DirtyF

This is ✨ great ✨ work as usual @benbalter 😻

mortenson · 2018-05-08T16:54:56Z

Thanks for pushing this forward @benbalter !

parkr

LGTM! Too bad we can't incorporate collection settings with feed settings, since we're basically duplicating that:

collections:
  changes:
    feed_path: "/feed/ch-ch-ch-changes.xslt"

parkr · 2018-05-08T18:54:36Z

lib/jekyll-feed/generator.rb

+      prefix = collection == "posts" ? "/feed" : "feed/#{collection}"
+      if category
+        "#{prefix}/#{category}.xml"
+      elsif collections[collection]["path"]


We should do nil checking here in case collections is nil or collections[collection] is nil

…l/jekyll-feed into categories-and-collections

benbalter · 2018-05-08T21:53:13Z

Too bad we can't incorporate collection settings with feed settings, since we're basically duplicating that

The settings for this were the toughest part. We could do, e.g.,:

collections:
  puppies:
    feed: true

or

collections:
  puppies:
    feed: 
      path: foo.xml
      categories:
        - foo

But that felt more complex and it would burry feed settings in collection settings, rather than following the pattern of a top-level key named after the plugin.

Could see it either way (and could always do both, although that feels SUPER complicated to explain the three ways you could configure it).

~~Unless anyone is strongly opinionated about the config, it sounds like this can merge with a bit more time for feedback?~~

Edit: Just saw @DirtyF requested @pathawks review.

pathawks · 2018-05-09T03:17:21Z

I would like to review this. Busy at the moment; please just give me a day or so 🙂

ashmaroli · 2018-05-09T10:49:53Z

README.md

+    - changes
+```
+
+By default, collection feeds will be outputted to `/feed/<COLLECTION>.xml`. If you'd like to customize the output path, specify a collection's custom path as follows:


IMHO ..will be output to reads better..

Or active voice: "The default output-path for collection feeds is /feed/<COLLECTION>.xml"

lib/jekyll-feed/generator.rb

ashmaroli · 2018-05-09T11:00:38Z

lib/jekyll-feed/generator.rb

+    # WIll return `/feed/collection.xml` for other collections
+    # Will return `/feed/collection/category.xml` for other collection categories
+    def feed_path(collection: "posts", category: nil)
+      prefix = collection == "posts" ? "/feed" : "feed/#{collection}"


why is there a leading slash for /feed.xml but not for feed/#{collection}.xml .. also, the comments above actually states the opposite..

Good catch. That is an oversight. Will push up a fix.

ashmaroli · 2018-05-09T11:12:16Z

spec/jekyll-feed_spec.rb

-      expect(contents).to match /http:\/\/example\.org\/bass\/2014\/03\/04\/march-the-fourth\.html/
-      expect(contents).to match /http:\/\/example\.org\/bass\/2014\/03\/02\/march-the-second\.html/
-      expect(contents).to match /http:\/\/example\.org\/bass\/2013\/12\/12\/dec-the-second\.html/
+      expect(contents).to match /http:\/\/example\.org\/bass\/updates\/2014\/03\/04\/march-the-fourth\.html/


not related to this PR.. but IMO enforcing the percent_r literal on the test files will avoid the need to escape the slashes here..

/cc @DirtyF

Yeah. Given the time, I'd also love to add unit tests to the generator and meta tag (rather than just relying on integration tests).

halirutan · 2018-08-06T03:37:05Z

That is great! When can we expect this getting merged?

mattmcmanus · 2018-09-06T17:18:07Z

I hate to be annoying, but I would LOVE to be able to use this feature. It looks like this PR has several approvals. Who's responsible to handle the merge and release? Is there anything a non-maintainer can do to help out here?

DirtyF · 2018-09-06T18:50:02Z

@jekyllbot: +minor

DirtyF · 2018-09-06T18:51:23Z

Thanks @mattmcmanus for the reminder, feel free to use the current master branch if you wanna test the feature before we release a proper gem

mattmcmanus · 2018-09-06T19:06:01Z

Yeah!

DirtyF · 2018-09-06T19:11:56Z

works like a charm, expect a release soon: https://frank.taillandier.me/feed/agile.xml

halirutan · 2018-09-07T07:03:09Z

I second this. A big YEAH!

dpocock · 2019-04-18T22:26:54Z

I've tried to use this on a Fedora system and it doesn't appear to be working:

$ rpm -qa | grep jekyll
rubygem-jekyll-feed-0.12.1-1.fc29.noarch
rubygem-jekyll-3.8.5-1.fc29.noarch
rubygem-jekyll-watch-2.2.1-1.fc29.noarch
rubygem-jekyll-sass-converter-1.5.2-2.fc29.noarch
rubygem-jekyll-seo-tag-2.6.0-1.fc29.noarch

I tried all the different permutations for category and categories

Here is a snippet of my _config.yml

plugins_dir:
  - jekyll-feed

feed:
  categories:
    - fedora
...

and from one of the blogs _posts/2019-04-07-sfk-2019-prishtina-toastmasters.html

...
category: fedora
...

and I also tried:

...
category: ['fedora']
...

A category-specific feed XML simply doesn't appear:

$ jekyll build
$ !fi
find . -name '*.xml'
./_site/feed.xml
./feed.xml

How should somebody troubleshoot in a situation like this?

ellenwyllie · 2019-05-10T15:38:16Z

This isn't working for me either. I added

feed:
  categories:
    - jakartaee

to my _config.yml and category: jakartaee to my blog post's front matter.

The feed for the category is being created, but it doesn't have any posts in it.

I've tried variations of category in the post, such as category: ['jakartaee'], categories: jakartaee and categories: ['jakartaee'] but none of them seem to work.

Does anyone know why this isn't working?

DirtyF · 2019-05-10T16:13:07Z

@ellenwyllie : category: jakartaee should work.

steven1046 · 2019-05-10T16:15:07Z

Does jekyll-feed rely on a certain version of jekyll-assets to work properly?

mortenson · 2019-05-10T17:00:00Z

@DirtyF categories: is what's documented in README.md, so I would expect it to work.

marco-c · 2019-05-11T10:02:28Z

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Categories and collections #228

Categories and collections #228

benbalter commented May 8, 2018

DirtyF left a comment

mortenson commented May 8, 2018

parkr left a comment

parkr May 8, 2018

benbalter commented May 8, 2018 •

edited

Loading

pathawks commented May 9, 2018

ashmaroli May 9, 2018

halirutan Aug 6, 2018

ashmaroli May 9, 2018

benbalter May 9, 2018

ashmaroli May 9, 2018

benbalter May 9, 2018

halirutan commented Aug 6, 2018

mattmcmanus commented Sep 6, 2018

DirtyF commented Sep 6, 2018

DirtyF commented Sep 6, 2018 •

edited

Loading

mattmcmanus commented Sep 6, 2018

DirtyF commented Sep 6, 2018

halirutan commented Sep 7, 2018

dpocock commented Apr 18, 2019

ellenwyllie commented May 10, 2019

DirtyF commented May 10, 2019

steven1046 commented May 10, 2019

mortenson commented May 10, 2019

marco-c commented May 11, 2019

Categories and collections #228

Categories and collections #228

Conversation

benbalter commented May 8, 2018

DirtyF left a comment

Choose a reason for hiding this comment

mortenson commented May 8, 2018

parkr left a comment

Choose a reason for hiding this comment

parkr May 8, 2018

Choose a reason for hiding this comment

benbalter commented May 8, 2018 • edited Loading

pathawks commented May 9, 2018

ashmaroli May 9, 2018

Choose a reason for hiding this comment

halirutan Aug 6, 2018

Choose a reason for hiding this comment

ashmaroli May 9, 2018

Choose a reason for hiding this comment

benbalter May 9, 2018

Choose a reason for hiding this comment

ashmaroli May 9, 2018

Choose a reason for hiding this comment

benbalter May 9, 2018

Choose a reason for hiding this comment

halirutan commented Aug 6, 2018

mattmcmanus commented Sep 6, 2018

DirtyF commented Sep 6, 2018

DirtyF commented Sep 6, 2018 • edited Loading

mattmcmanus commented Sep 6, 2018

DirtyF commented Sep 6, 2018

halirutan commented Sep 7, 2018

dpocock commented Apr 18, 2019

ellenwyllie commented May 10, 2019

DirtyF commented May 10, 2019

steven1046 commented May 10, 2019

mortenson commented May 10, 2019

marco-c commented May 11, 2019

benbalter commented May 8, 2018 •

edited

Loading

DirtyF commented Sep 6, 2018 •

edited

Loading